PDS Mini Services
Domain Message Specification

Version: 1.1; Status: Final

getNHSNumberRequest-v1-0 Tabular View

Static model: getNHSNumberRequest-v1-0 - QUPA_RM000002GB01

Date: 04 April 2011 11:47:50 BST
getNHSNumberRequest-v1-0
Used by:
classCode: CS [1..1] {M = CACT} Indicates that this is a Control Act.
moodCode: CS [1..1] {M = EVN} Indicates that this is an Event.
id: II.NHS.IdentifierType2 [1..1] {M}

This is a unique identifier for this instance of the message.

The II.NHS.IdentifierType2 flavour shall be used to carry this information as follows:

  • The root attribute will contain a DCE UUID.
code: CV.NHS.CodedValueType1 [1..1] {M = C:MiniServiceMessageType#getNHSNumberRequest-v1-0}

A code which indicates the type of message.

The CV.NHS.CodedValueType1 data type flavour is used to carry the information as follows:

  • The code attribute is fixed to the value indicated.
  • The codeSystem attribute shall contain the OID for the vocabulary indicated.
queryEvent 1..1 {M} (getNHSNumberRequest-v1-0Grouper)

getNHSNumberRequest-v1-0Grouper
Used by: getNHSNumberRequest-v1-0 		The main query class.
Person.DateOfBirth 1..1 {M} (Person.DateOfBirth)
Person.Gender 1..1 {M} (Person.Gender)
Person.LocalIdentifier 0..1 {U} (Person.LocalIdentifier)
Person.Name 1..1 {M} (Person.Name)
Person.Postcode 0..1 {U} (Person.Postcode)

Person.DateOfBirth
Used by: getNHSNumberRequest-v1-0Grouper 		Provides information about the Date of Birth.
value: TS.NHS.TimestampType4 [1..1] {M}

The value of the date of birth for the patient.

The TS.NHS.TimestampType4 data type flavour is used to carry this information as follows:

  • The value attribute will contain the date in the format YYYYMMDD or YYYYMM or YYYY.
semanticsText: ST [1..1] {M = "Person.DateOfBirth"}

A literal text string identifying the parameter item.


Person.Gender
Used by: getNHSNumberRequest-v1-0Grouper 		Provides information about the Gender.
value: CV.NHS.CodedValueType1 [1..1] {M < V:Sex CNE} { CNE:Sex }

A code which indicates the gender.

The CV data type is used to carry the information as follows:

  • The code attribute is fixed to the value indicated.
  • The codeSystem attribute shall contain the OID for the vocabulary indicated
semanticsText: ST [1..1] {M = "Person.Gender"}

A literal text string identifying the parameter item.


Person.LocalIdentifier
Used by: getNHSNumberRequest-v1-0Grouper 		Provides information about the Local Identifier.
value: II.NHS.IdentifierType3 [1..1] {M} The value of a local identifier.

The II.NHS.IdentifierType3 data type flavour is used to carry this information as follows:
  • The root attribute will contain an OID
  • The extension attribute will contain the value of the identifier.
In the absence of a local OID, the OID 2.16.840.1.113883.2.1.3.2.4.18.24 (Local Person Identifier) may be used.
semanticsText: ST [1..1] {M = "Person.LocalIdentifier"} A literal text string identifying the parameter item. A literal text string identifying the parameter item.

Person.Name
Used by: getNHSNumberRequest-v1-0Grouper 		Provides information about the Name.
value: PN.NHS.PersonNameType3 [1..1] {M}

The value of the name for the patient.

The PN.NHS.PersonNameType3 flavour is used to carry this information as follows:

  • The family element must be populated with the family name.
  • The given element may be populated with the given name.
semanticsText: ST [1..1] {M = "Person.Name"}

A literal text string identifying the parameter item.


Person.Postcode
Used by: getNHSNumberRequest-v1-0Grouper 		Provides information about the Postcode.
value: AD.NHS.AddressType1 [1..1] {M}

The value of the postcode for the patient.

The AD.NHS.AddressType1 data type flavour is used to carry this information as follows:

  • The postalCode element will be used to carry the postcode.
semanticsText: ST [1..1] {M = "Person.Postcode"}

A literal text string identifying the parameter item.